<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>Nodes | Fans</title>
    <meta name="description" content="The Fans app REST API docs.">
    <link rel="shortcut icon" href="/docs/favicon.ico">
  <link rel="icon" href="/docs/fans.svg">
  <link rel="mask-icon" href="/docs/fans.svg">
    
    <link rel="preload" href="/docs/assets/css/0.styles.96586f63.css" as="style"><link rel="preload" href="/docs/assets/js/app.adb254f4.js" as="script"><link rel="preload" href="/docs/assets/js/2.0613674a.js" as="script"><link rel="preload" href="/docs/assets/js/9.08fd7d8a.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.443b0da9.js"><link rel="prefetch" href="/docs/assets/js/11.5914f244.js"><link rel="prefetch" href="/docs/assets/js/12.7e19e4ef.js"><link rel="prefetch" href="/docs/assets/js/13.bf31197c.js"><link rel="prefetch" href="/docs/assets/js/14.325025c5.js"><link rel="prefetch" href="/docs/assets/js/15.fe04ddd5.js"><link rel="prefetch" href="/docs/assets/js/16.db0ffebf.js"><link rel="prefetch" href="/docs/assets/js/3.f7ca2ebe.js"><link rel="prefetch" href="/docs/assets/js/4.c9eaa668.js"><link rel="prefetch" href="/docs/assets/js/5.19f5b095.js"><link rel="prefetch" href="/docs/assets/js/6.28cd1744.js"><link rel="prefetch" href="/docs/assets/js/7.407974dd.js"><link rel="prefetch" href="/docs/assets/js/8.5d06e407.js">
    <link rel="stylesheet" href="/docs/assets/css/0.styles.96586f63.css">
  </head>
  <body>
    <div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/docs/" class="home-link router-link-active"><!----> <span class="site-name">Fans</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/docs/" class="nav-link">Home</a></div><div class="nav-item"><a href="/docs/api/" class="nav-link router-link-active">Docs</a></div><div class="nav-item"><a href="https://github.com/medz/fans" target="_blank" rel="noopener noreferrer" class="nav-link external">
  GitHub
  <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/docs/" class="nav-link">Home</a></div><div class="nav-item"><a href="/docs/api/" class="nav-link router-link-active">Docs</a></div><div class="nav-item"><a href="https://github.com/medz/fans" target="_blank" rel="noopener noreferrer" class="nav-link external">
  GitHub
  <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav>  <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Kernel</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/docs/api/" class="sidebar-link">Overview</a></li><li><a href="/docs/api/authorizations.html" class="sidebar-link">Authorizations</a></li><li><a href="/docs/api/comments.html" class="sidebar-link">Comments</a></li><li><a href="/docs/api/itc.html" class="sidebar-link">International Telephone Codes</a></li><li><a href="/docs/api/jurisdictions.html" class="sidebar-link">Jurisdictions</a></li><li><a href="/docs/api/talks.html" class="sidebar-link">Talks</a></li><li><a href="/docs/api/upload.html" class="sidebar-link">Upload File</a></li><li><a href="/docs/api/users.html" class="sidebar-link">Users</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>Forum</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/docs/api/forum/nodes.html" class="active sidebar-link">Nodes</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/forum/nodes.html#list-all-nodes" class="sidebar-link">List all nodes</a></li><li class="sidebar-sub-header"><a href="/docs/api/forum/nodes.html#get-a-single-node" class="sidebar-link">Get a single node</a></li><li class="sidebar-sub-header"><a href="/docs/api/forum/nodes.html#create-on-an-node" class="sidebar-link">Create on an node</a></li><li class="sidebar-sub-header"><a href="/docs/api/forum/nodes.html#edit-a-node" class="sidebar-link">Edit a node</a></li><li class="sidebar-sub-header"><a href="/docs/api/forum/nodes.html#delete-a-node" class="sidebar-link">Delete a node</a></li></ul></li><li><a href="/docs/api/forum/threads.html" class="sidebar-link">Threads</a></li></ul></section></li></ul> </aside> <main class="page"> <div class="content default"><h2 id="list-all-nodes"><a href="#list-all-nodes" aria-hidden="true" class="header-anchor">#</a> List all nodes</h2> <div class="language- extra-class"><pre class="language-text"><code>GET {uri}/forum/nodes
</code></pre></div><p>Response:</p> <div class="language-json extra-class"><pre class="language-json"><code>Status<span class="token operator">:</span> <span class="token number">200</span> OK
<span class="token punctuation">[</span>
    <span class="token punctuation">{</span>
        <span class="token property">&quot;id&quot;</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span>
        <span class="token property">&quot;name&quot;</span><span class="token operator">:</span> <span class="token string">&quot;Node 1&quot;</span><span class="token punctuation">,</span>
        <span class="token property">&quot;description&quot;</span><span class="token operator">:</span> <span class="token null">null</span><span class="token punctuation">,</span>
        <span class="token property">&quot;icon&quot;</span><span class="token operator">:</span> <span class="token null">null</span><span class="token punctuation">,</span>
        <span class="token property">&quot;color&quot;</span><span class="token operator">:</span> <span class="token null">null</span><span class="token punctuation">,</span>
        <span class="token property">&quot;counts&quot;</span><span class="token operator">:</span> <span class="token punctuation">{</span>
            <span class="token property">&quot;threads&quot;</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span>
            <span class="token property">&quot;followers&quot;</span><span class="token operator">:</span> <span class="token number">0</span>
        <span class="token punctuation">}</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">]</span>
</code></pre></div><h2 id="get-a-single-node"><a href="#get-a-single-node" aria-hidden="true" class="header-anchor">#</a> Get a single node</h2> <div class="language- extra-class"><pre class="language-text"><code>GET {uri}/forum/nodes/{id}
</code></pre></div><p>Response:</p> <div class="language-json extra-class"><pre class="language-json"><code>Status<span class="token operator">:</span> <span class="token number">200</span> OK
<span class="token punctuation">{</span>
    <span class="token property">&quot;id&quot;</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span>
    <span class="token property">&quot;name&quot;</span><span class="token operator">:</span> <span class="token string">&quot;Node 1&quot;</span><span class="token punctuation">,</span>
    <span class="token property">&quot;description&quot;</span><span class="token operator">:</span> <span class="token null">null</span><span class="token punctuation">,</span>
    <span class="token property">&quot;icon&quot;</span><span class="token operator">:</span> <span class="token null">null</span><span class="token punctuation">,</span>
    <span class="token property">&quot;color&quot;</span><span class="token operator">:</span> <span class="token null">null</span><span class="token punctuation">,</span>
    <span class="token property">&quot;counts&quot;</span><span class="token operator">:</span> <span class="token punctuation">{</span>
        <span class="token property">&quot;threads&quot;</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span>
        <span class="token property">&quot;followers&quot;</span><span class="token operator">:</span> <span class="token number">0</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><h2 id="create-on-an-node"><a href="#create-on-an-node" aria-hidden="true" class="header-anchor">#</a> Create on an node</h2> <div class="language- extra-class"><pre class="language-text"><code>POST {uri}/forum/nodes
</code></pre></div><p>Input:</p> <table><thead><tr><th>Name</th> <th>Type</th> <th>Description</th></tr></thead> <tbody><tr><td><code>name</code></td> <td><code>string</code></td> <td><strong>Required</strong>, The name of the node.</td></tr> <tr><td><code>description</code></td> <td><code>string</code></td> <td>The description of the node.</td></tr> <tr><td><code>color</code></td> <td><code>string</code></td> <td>Set the node background color.</td></tr> <tr><td><code>icon</code></td> <td><code>string</code></td> <td>The icon is image filename.</td></tr></tbody></table> <p>Response:</p> <div class="language-json extra-class"><pre class="language-json"><code>Status<span class="token operator">:</span> <span class="token number">201</span> Created
<span class="token punctuation">{</span>
    <span class="token property">&quot;id&quot;</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span>
    <span class="token property">&quot;name&quot;</span><span class="token operator">:</span> <span class="token string">&quot;Node 1&quot;</span><span class="token punctuation">,</span>
    <span class="token property">&quot;description&quot;</span><span class="token operator">:</span> <span class="token null">null</span><span class="token punctuation">,</span>
    <span class="token property">&quot;icon&quot;</span><span class="token operator">:</span> <span class="token null">null</span><span class="token punctuation">,</span>
    <span class="token property">&quot;color&quot;</span><span class="token operator">:</span> <span class="token null">null</span><span class="token punctuation">,</span>
    <span class="token property">&quot;counts&quot;</span><span class="token operator">:</span> <span class="token punctuation">{</span>
        <span class="token property">&quot;threads&quot;</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span>
        <span class="token property">&quot;followers&quot;</span><span class="token operator">:</span> <span class="token number">0</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><h2 id="edit-a-node"><a href="#edit-a-node" aria-hidden="true" class="header-anchor">#</a> Edit a node</h2> <div class="warning custom-block"><p class="custom-block-title">WARNING</p> <p>Need jurisdiction:<code>forum:nodes-manage</code>.</p></div> <div class="language- extra-class"><pre class="language-text"><code>PUT|PATCH {uri}/forum/nodes/{id}
</code></pre></div><p>Input:</p> <table><thead><tr><th>Name</th> <th>Type</th> <th>Description</th></tr></thead> <tbody><tr><td><code>name</code></td> <td><code>string</code></td> <td>The name of the node.</td></tr> <tr><td><code>description</code></td> <td><code>string</code></td> <td>The description of the node.</td></tr> <tr><td><code>color</code></td> <td><code>string</code></td> <td>Set the node background color.</td></tr> <tr><td><code>icon</code></td> <td><code>string</code></td> <td>The icon is image filename.</td></tr></tbody></table> <p>Response:</p> <div class="language- extra-class"><pre class="language-text"><code>Status: 204 No Content
</code></pre></div><h2 id="delete-a-node"><a href="#delete-a-node" aria-hidden="true" class="header-anchor">#</a> Delete a node</h2> <div class="warning custom-block"><p class="custom-block-title">WARNING</p> <p>Need jurisdiction:<code>forum:nodes-manage</code>.</p></div> <div class="language- extra-class"><pre class="language-text"><code>DELETE {uri}/forum/nodes/{id}
</code></pre></div><p>Input:</p> <table><thead><tr><th>Name</th> <th>Type</th> <th>Description</th></tr></thead> <tbody><tr><td><code>node</code></td> <td><code>integer</code></td> <td>The thread under the deleted node needs to be moved to the specified node.</td></tr></tbody></table> <p>Response:</p> <div class="language- extra-class"><pre class="language-text"><code>Status: 204 No Content
</code></pre></div></div> <footer class="page-edit"><!----> <!----></footer> <div class="page-nav"><p class="inner"><span class="prev">
        ←
        <a href="/docs/api/users.html" class="prev">
          Users
        </a></span> <span class="next"><a href="/docs/api/forum/threads.html">
          Threads
        </a>
        →
      </span></p></div> </main></div><div class="global-ui"></div></div>
    <script src="/docs/assets/js/app.adb254f4.js" defer></script><script src="/docs/assets/js/2.0613674a.js" defer></script><script src="/docs/assets/js/9.08fd7d8a.js" defer></script>
  </body>
</html>
